If you are reading this file by selecting it from the Apple Help menu, and want to know where this and the other files listed in the Help menu are located, open the ProTERM folder, and locate and open the folder named Help.
** Help Folder **
If you have opened the ProTERM Help folder, and opened this file, you may wonder why this and several other files are placed in this folder, and if they should or could be moved or removed.
All files in this folder show as a Help file list in the Apple Help menu (upper left corner of the Macintosh status bar) when ProTERM is the active application. Try it, click on the Apple menu, pull down to Help, and you will see the list of files in this (Help) folder.
* Formatting Note *
When you look at this document as opened via the Help menu, it will appear in a noticeably different format than if you open the document directly from the Help folder, and this demonstrates some of ProTERMﾕs special features: Both Index formatting and Dot-command formatting are used, and you can see the result of the formatting by comparing the differences.
* Indexed Files *
In addition to having a different format, when the file is opened from the Help menu, you will also see an additional window, this small window is called a windoid, and it contains an ﾒIndexedﾓ outline of the subject leaders in this document. Windoids are application sensitive, are always the topmost object and cannot be hidden behind any window used in that same application. This means when ProTERM is being used, and a windoid is open, it will be the top-most document. Windoids can be moved, resized and closed, and they remember their size and position when reopened. To move the windoid, click and drag the windoidﾕs title bar, to resize, click and drag the grow box (lower right corner), and to close, click the close box (upper left corner).
Double-click on one of the indexed items (lines) in the windoid, and that subject will be found and marked in the main document. Note that the subject leader that was found and is selected, has a quantity of asterisks leading and trailing the header. See an explanation with examples of this index formatting later in this document.
As noted, the formatting is noticeably different when you open this document directly from the Help folder. When the document is opened from the Help folder and not from the Help menu, you will not see the windoid, and you will not see the special formatting that takes place when the file is opened from the Help menu. What you will see, are the visible formatting commands. This is due to ProTERMﾕs Indexing routine, and special formatting that takes place when the document is opened from the Help menu (or by using Format Test from the Edit menu, or by changing the document file type). For more detail on these features, contact InTrec Technical Support.
** Creating Your Own Help Files **
You can create your own personal help or address files, save them in this folder, and they will show up after you restart ProTERM. When a file is opened from the Help menu, it cannot be altered, other than through Drag and Drop. To create or alter a file to be used in the Help menu, open the file directly from the Help folder, not through the Help menu. To further protect the document from alteration, lock the document using the Get Info command.
Another example of these kinds of files applies to school use where a student would call into a schoolﾕs central online service and use files from the Help menu for lists of answers or replies to drag and drop onto an answer form.
** Help File Examples **
To create your own Help file or email address or Web site address file:
ｼlm3ｼｼpm-2ｼ
1 Choose New from the File menu.
2 Type your text or list, and save the file to the Help folder.
3 Quit and restart ProTERM, and your file will be available in the Help menu.
ｼlmｼｼpmｼ
You can select text, and drag the selection to another window. For example, if you created a file with all of your popular email addresses or URLs (Web site addresses), you could open your special address file in the Help menu, select the desired text, and drag the selection to the terminal window where it would paste at the cursor position in the terminal window.
** Self Indexing **
Any file placed in the Help file can be self indexing when read from the Help menu:
ｼlm3ｼｼpm-2ｼ
･ Place asterisks before and after the indexed text.
･ The leading (left) asterisks must touch the left margin.
･ The maximum number of characters between asterisks is 31.
･ As in any proper outline, the maximum off-set (number of asterisks is always used at the top of the outline, then subsequent steps always follow. For example three asterisks, then two then one, never one, two three.
･ There must be a space between the asterisks and the after the ﾓindexedﾓ text.
･ The indexed lines must be on a line by themselves.
ｼlmｼｼpmｼ
The more asterisks used, the more weight given to the ﾒoutline-styleﾓ offset, (indent). For example, five asterisks would allow four subset indexes. In an example where five asterisks were used to offset the first entry, and then four additional graduated subentries (4 asterisk, 3 asterisk, 2 asterisk, 1 asterisk), were entered subsequent to the header, the text with the five asterisks would be shown in the Index windoid offset five spaces to the left from the lowest subset (a single set of asterisks). Four asterisks would offset four spaces to the right, three would offset three, etc. An indexed header starting with five asterisks as noted here would cause an index to look like this:
* Self Indexing Example *
NOTE: The quotes used in this example ﾒhideﾓ this set so they are
just used as an example. Do not use quotes for actual indexing.
ﾒ***** Primary outline offset *****ﾓ (The maximum used must be at the top)
ﾒ**** Secondary outline offset ****ﾓ
ﾒ*** Tertiary outline offset ***ﾓ
ﾒ** Sub outline offset **ﾓ
ﾒ* Sub-sub outline offset *ﾓ
The Index windoid would show the following.
Five ASTERISK example
Four ASTERISK example
Three ASTERISK example
Two ASTERISK example
One ASTERISK example
You may only choose to use a one asterisk offset, or maybe two or three. They will work as long as you always have the primary offset (the offset with the most asterisks used in the document ahead of secondary or tertiary, offset titles). Note that a maximum of four asterisks are used in this documentﾕs formatting because that quantity provided the required level of formatting needed for this document.
* Make Index Command *
As you experiment with the Indexing format, you can choose the Make Index from the ProTERM Edit menu to test your work.
** Dot-Command Formatting **
If you are interested in the special formatting used in this and other ProTERM documents, ask the InTrec Technical Support Dept. for instructions on the use of ProTERM Mac dot-commands.
